TryTake Method (T, Int32)

Task Parallel System.Threading

Attempts to remove an item from the BlockingCollection<(Of <(T>)>).

Namespace:  System.Collections.Concurrent
Assembly:  System.Threading (in System.Threading.dll)

Syntax

Visual Basic (Declaration)
Public Function TryTake ( _
	<OutAttribute> ByRef item As T, _
	millisecondsTimeout As Integer _
) As Boolean
C#
public bool TryTake(
	out T item,
	int millisecondsTimeout
)

Parameters

item
Type: T %
The item removed from the collection.
millisecondsTimeout
Type: System..::.Int32
The number of milliseconds to wait, or Infinite (-1) to wait indefinitely.

Return Value

true if an item could be removed from the collection within the alloted time; otherwise, false.

Exceptions

ExceptionCondition
System..::.ObjectDisposedExceptionThe BlockingCollection<(Of <(T>)>) has been disposed.
System..::.ArgumentOutOfRangeExceptionmillisecondsTimeout is a negative number other than -1, which represents an infinite time-out.
System..::.InvalidOperationExceptionThe underlying collection was modified outside of this BlockingCollection<(Of <(T>)>) instance.

See Also